Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Update terminology 'Integrations' to 'Extensions' #2170

Closed
wants to merge 1 commit into from

Conversation

dmaskasky
Copy link
Collaborator

@dmaskasky dmaskasky commented Oct 11, 2023

Related Issues or Discussions

Resolves #2169

Summary

  • Replace instances of integrations with extensions throughout the website documentation.
  • Update navigation, headers, and section titles accordingly.
  • Ensure consistency in term usage across all documentation pages.

Check List

  • yarn run prettier for formatting code and docs

@vercel
Copy link

vercel bot commented Oct 11, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
jotai ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 23, 2023 6:04am

@codesandbox-ci
Copy link

codesandbox-ci bot commented Oct 11, 2023

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 73f4bf9:

Sandbox Source
React Configuration
React TypeScript Configuration
React Browserify Configuration
React Snowpack Configuration
Next.js Configuration
Next.js with custom Babel config Configuration
React with custom Babel config Configuration

@dai-shi
Copy link
Member

dai-shi commented Oct 11, 2023

I didn't realize when looking at #2169, but this gives me feel "Ecosystem" is too broad. Because, "SWC", "Babel", "Devtools" in "Tools" can also be considered as ecosystem. So, maybe we want a narrower term.

@dmaskasky
Copy link
Collaborator Author

I didn't realize when looking at #2169, but this gives me feel "Ecosystem" is too broad. Because, "SWC", "Babel", "Devtools" in "Tools" can also be considered as ecosystem. So, maybe we want a narrower term.

Hmm, what should we use instead?

@sandren
Copy link
Collaborator

sandren commented Oct 12, 2023

Hmm, what should we use instead?

Thanks for the PR! "Extensions" is the first thing that comes to mind, but I'll let others chime in with suggestions as well. 🙂

@dmaskasky
Copy link
Collaborator Author

Thanks for the PR! "Extensions" is the first thing that comes to mind, but I'll let others chime in with suggestions as well. 🙂

21 ideas:

  1. Add Ons
  2. Community Add Ons
  3. Community Enhancements
  4. Community Extensions
  5. Community Modules
  6. Community Packages
  7. Community Plugins
  8. Ecosystem
  9. Enhancements
  10. Extensions
  11. Modules
  12. Packages
  13. Plugins
  14. Third-Party
  15. Third-Party Add Ons
  16. Third-Party Ecosystem
  17. Third-Party Enhancements
  18. Third-Party Extensions
  19. Third-Party Modules
  20. Third-Party Packages
  21. Third-Party Plugins

@sandren
Copy link
Collaborator

sandren commented Oct 23, 2023

@dmaskasky Let's go with "Extensions". Thanks! 🙂

@dai-shi
Copy link
Member

dai-shi commented Oct 23, 2023

@sandren Is it possible to have a redirect (for the website) from integrations to extensions to avoid "404"?

@dmaskasky
Copy link
Collaborator Author

@sandren Is it possible to have a redirect (for the website) from integrations to extensions to avoid "404"?
How is this done?

@dmaskasky dmaskasky force-pushed the jotai-ecosystem-docs branch from 6fa54d3 to d126e7c Compare October 23, 2023 05:47
@dmaskasky dmaskasky changed the title doc: Update terminology 'Integrations' to 'Ecosystem' doc: Update terminology 'Integrations' to 'Extensions' Oct 23, 2023
@dmaskasky
Copy link
Collaborator Author

image

@dmaskasky
Copy link
Collaborator Author

image

@sandren
Copy link
Collaborator

sandren commented Oct 23, 2023

How is this done?

Redirects are handled in gatsby-node.js:

createRedirect({
  fromPath: `/docs/integrations/*`,
  toPath: `/docs/extensions/*`,
  isPermanent: false,
});

- Replace instances of integrations with extensions throughout the website documentation.
- Update navigation, headers, and section titles accordingly.
- Ensure consistency in term usage across all documentation pages.
@dmaskasky
Copy link
Collaborator Author

How is this done?

Redirects are handled in gatsby-node.js:

createRedirect({
  fromPath: `/docs/integrations/*`,
  toPath: `/docs/extensions/*`,
  isPermanent: false,
});

This didn't work for me locally. I have included this in the PR. Could you please test this?

@dmaskasky
Copy link
Collaborator Author

Also, I could use some advice with git.

I am unsure why GH is reporting a conflict with docs/integrations/scope.mdx. I have already rebased.

jotai jotai-ecosystem-docs $ git fetch && git rebase origin/main
Current branch jotai-ecosystem-docs is up to date.
jotai jotai-ecosystem-docs $ git fetch upstream && git rebase upstream/main
Current branch jotai-ecosystem-docs is up to date.
jotai jotai-ecosystem-docs $ pwd       
/Users/davidmaskasky/Code/jotai

@sandren
Copy link
Collaborator

sandren commented Oct 23, 2023

This didn't work for me locally. I have included this in the PR. Could you please test this?

It's not working in the deploy preview either. I think we'll need to add an explicit redirect for each integration -> extension like the utils -> utilities redirects above.

@dmaskasky
Copy link
Collaborator Author

This didn't work for me locally. I have included this in the PR. Could you please test this?

It's not working in the deploy preview either. I think we'll need to add an explicit redirect for each integration -> extension like the utils -> utilities redirects above.

That sounds like an unnecessary maintenance burden. Wildcards should work, not sure why they don't though. I don't have a lot of experience with Gatsby.

@dmaskasky dmaskasky closed this Nov 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants